damondouglas commented on a change in pull request #15721: URL: https://github.com/apache/beam/pull/15721#discussion_r731970681
########## File path: playground/backend/internal/cache/cache.go ########## @@ -0,0 +1,52 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package cache + +import ( + "context" + "github.com/google/uuid" + "os" + "time" +) + +type SubKey string + +const ( + SubKey_Status SubKey = "STATUS" + SubKey_RunOutput SubKey = "RUN_OUTPUT" + SubKey_CompileOutput SubKey = "COMPILE_OUTPUT" +) + +type Cache interface { + // GetValue returns value from cache by pipelineId and subKey. + GetValue(ctx context.Context, pipelineId uuid.UUID, subKey SubKey) (interface{}, error) + + // SetValue adds value to cache by pipelineId and subKey. + SetValue(ctx context.Context, pipelineId uuid.UUID, subKey SubKey, value interface{}) error + + // SetExpTime adds expiration time of the pipeline to cache by pipelineId. + SetExpTime(ctx context.Context, pipelineId uuid.UUID, expTime time.Duration) error +} + +// NewCache returns new cache to save and read value +func NewCache(ctx context.Context, cacheType string) (Cache, error) { Review comment: May we consider just naming this to `New`? ########## File path: playground/backend/internal/cache/cache.go ########## @@ -0,0 +1,52 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. + +package cache + +import ( + "context" + "github.com/google/uuid" + "os" + "time" +) + +type SubKey string + +const ( + SubKey_Status SubKey = "STATUS" + SubKey_RunOutput SubKey = "RUN_OUTPUT" + SubKey_CompileOutput SubKey = "COMPILE_OUTPUT" +) + +type Cache interface { + // GetValue returns value from cache by pipelineId and subKey. + GetValue(ctx context.Context, pipelineId uuid.UUID, subKey SubKey) (interface{}, error) + + // SetValue adds value to cache by pipelineId and subKey. + SetValue(ctx context.Context, pipelineId uuid.UUID, subKey SubKey, value interface{}) error + + // SetExpTime adds expiration time of the pipeline to cache by pipelineId. + SetExpTime(ctx context.Context, pipelineId uuid.UUID, expTime time.Duration) error +} + +// NewCache returns new cache to save and read value +func NewCache(ctx context.Context, cacheType string) (Cache, error) { + switch cacheType { + case "remote": + return newRedisCache(ctx, os.Getenv("remote_cache_address")) Review comment: What do you think about leaving the `Cache` interface in the `cache` package and additionally creating a local folder and redis folder. In each of the local and redis folders have a New method that defines the constructor-like parameters needed for each? The design pattern allows knowledge by the instantiator of the cache but the usage of the cache by the service should only receive the interface? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
