Class: Fog::Cache

Inherits:
Object
  • Object
show all
Defined in:
lib/fog/core/cache.rb

Overview

A generic cache mechanism for fog resources. This can be for a server, security group, etc.

Currently this is a on-disk cache using yml files per-model instance, however there is nothing in the way of extending this to use various other cache backends.

Basic functionality

set the namespace where this cache will be stored:

Fog::Cache.namespace_prefix = “service-account-foo-region-bar”

cache to disk:

# after dumping, there will be a yml file on disk:
resouce.cache.dump

# you can load cached data in from a different session
Fog::Cache.load(Fog::Compute::AWS::Server, compute)

# you can also expire cache (removes cached data assocaited with the resources of this model associated to the service passed in).
Fog::Cache.expire_cache!(Fog::Compute::AWS::Server, compute)

More detailed flow/usage

Normally, you would have a bunch of resources you want to cache/reload from disk. Every fog model has a cache object injected to accomplish this. So in order to cache a server for exmaple you would do something like this:

# note this is necessary in order to segregate usage of cache between various providers regions and accounts.
# if you are using one account/region/etc only, you still must set it. 'default' will do.
Fog::Cache.namespace_prefix = "prod-emea-eu-west-1"

s = security_groups.sample; s.name # => "default"
s.cache.dump # => 2371

Now it is on disk:

shai@adsk-lappy ~ % tree ~/.fog-cache/prod-emea-eu-west-1/

/Users/shai/.fog-cache/prod-emea-eu-west-1/
  └── fog_compute_aws_real
    └── fog_compute_aws_securitygroup
     ├── default-90928073d9d5d9b4e7545e88aee7ec4f.yml

You can do the same with a SecurityGroup, Instances, Elbs, etc.

Note that when loading cache from disk, you need to pass the appropriate model class, and service associated with it. Service is passed in is so that the service/connection details can be loaded into the loaded instances so they can be re-queried, etc. Model is passed in so we can find the cache data associated to that model in the namespace of cache this session is using: Will try to load all resources associated to those. If you had 1 yml file, or 100, it would load whatever it could find. As such, the normal usage of dumping would be do it on a collection:

load_balancers.each {|elb| elb.cache.dump }

In order to load the cache into a different session with nothing but the service set up, use like so: As mentioned, will load all resources associated to the model_klass and service passed in.

instances = Fog::Cache.load(Fog::Compute::AWS::Server, compute)
instances.first.id # => "i-0569a70ae6f47d229"

Note that if there is no cache located for the model class and service passed to ‘Fog::Cache.load` you will get an exception you can handle (for example, to load the resources for the fisrt time):

Fog::Cache.expire_cache!(Fog::Compute::AWS::SecurityGroup, compute)
# ... now there is no SecurityGroup cache data. So, if you tried to load it, you would get an exception:

Fog::Cache.load(Fog::Compute::AWS::SecurityGroup, compute)
  rescue Fog::Cache::CacheNotFound => e
    puts "could not find any cache data for security groups on #{compute}"
    get_resources_and_dump

Extending cache backends

Currently this is on-disk using yml. If need be, this could be extended to other cache backends:

Find references of yaml in this file, split out to strategy objects/diff backends etc.

Defined Under Namespace

Classes: CacheDir, CacheNotFound

Constant Summary collapse

SANDBOX =

where different caches per service api keys, regions etc, are stored see the namespace_prefix= method.

ENV["HOME"] ? File.expand_path("~/.fog-cache") : File.expand_path(".fog-cache")
REQUIRED_ATTRIBUTES =

required attributes to load model from cache

[:identity, :collection_klass, :collection_attrs, :model_klass, :model_attrs].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(model) ⇒ Cache

Returns a new instance of Cache.



260
261
262
 
# File 'lib/fog/core/cache.rb', line 260

def initialize(model)
  @model = model
end

Instance Attribute Details

#model ⇒ Object (readonly)

when a resource is used such as ‘server.cache.dump` the model klass is passed in so that it can be identified from a different session.



101
102
103
 
# File 'lib/fog/core/cache.rb', line 101

def model
  @model
end

Class Method Details

.clean! ⇒ Object

cleans the ‘SANDBOX` - specific any resource cache of any namespace, and any metadata associated to any.



183
184
185
 
# File 'lib/fog/core/cache.rb', line 183

def self.clean!
  FileUtils.rm_rf(SANDBOX)
end

.create_namespace(model_klass, service) ⇒ Object

creates on-disk cache of this specific model_klass and @service



171
172
173
 
# File 'lib/fog/core/cache.rb', line 171

def self.create_namespace(model_klass, service)
  FileUtils.mkdir_p(self.namespace(model_klass, service))
end

.expire_cache!(model_klass, service) ⇒ Object

Expires cache - this does not expire all cache associated. Instead, this will remove all on-disk cache of this specific model_klass and and @service



177
178
179
 
# File 'lib/fog/core/cache.rb', line 177

def self.expire_cache!(model_klass, service)
  FileUtils.rm_rf(namespace(model_klass, service))
end

.load(model_klass, service) ⇒ Object

Loads cache associated to the model_klass and service into memory.

If no cache is found, it will raise an error for handling:

rescue Fog::Cache::CacheNotFound
  set_initial_cache

Raises:



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/fog/core/cache.rb', line 110

def self.load(model_klass, service)
  cache_files = Dir.glob("#{namespace(model_klass, service)}/*")

  raise CacheNotFound if cache_files.empty?

  # collection_klass and model_klass should be the same across all instances
  # choose a valid cache record from the dump to use as a sample to deterine
  # which collection/model to instantiate.
  sample_path = cache_files.detect { |path| valid_for_load?(path) }
  model_klass = Object.const_get(load_cache(sample_path)[:model_klass])
  collection_klass = Object.const_get(load_cache(sample_path)[:collection_klass]) if load_cache(sample_path)[:collection_klass]

  # Load the cache data into actual ruby instances
  loaded = cache_files.map do |path|
    next unless valid_for_load?(path)

    cache = load_cache(path)

    # make sure attributes are not nil
    cache[:collection_attrs] ||= {}
    cache[:model_attrs] ||= {}

    m = model_klass.new(cache[:model_attrs])

    # Set the collection and service so they can be reloaded/connection is set properly.
    # See https://github.com/fog/fog-aws/issues/354#issuecomment-286789702
    m.instance_variable_set(:@service, service)
    m.collection = collection_klass.new(cache[:collection_attrs].merge(service: service)) if collection_klass

    m
  end.compact

  # uniqe-ify based on the total of attributes. duplicate cache can exist due to
  # `model#identity` not being unique. but if all attributes match, they are unique
  # and shouldn't be loaded again.
  uniq_loaded = loaded.uniq { |i| i.attributes }
  if uniq_loaded.size != loaded.size
    Fog::Logger.warning("Found duplicate items in the cache. Expire all & refresh cache soon.")
  end

  # Fog models created, free memory of cached data used for creation.
  @memoized = nil

  uniq_loaded
end

.load_cache(path) ⇒ Object

loads yml cache from path on disk, used to initialize Fog models.



199
200
201
202
203
204
 
# File 'lib/fog/core/cache.rb', line 199

def self.load_cache(path)
  @memoized ||= {}
  return @memoized[path] if @memoized[path]

  @memoized[path] = yaml_load(File.read(path))
end

.metadata ⇒ Object

retrive metadata for this namespace of cache. returns empty {} if none found.



239
240
241
242
243
244
245
246
 
# File 'lib/fog/core/cache.rb', line 239

def self.metadata
  mpath = File.join(SANDBOX, namespace_prefix, "metadata.yml")
  if File.exist?(mpath)
    yaml_load(File.read(mpath))
  else
    {}
  end
end

.namespace(model_klass, service) ⇒ Object

The path/namespace where the cache is stored for a specific model_klass and @service.

Raises:



249
250
251
252
253
254
 
# File 'lib/fog/core/cache.rb', line 249

def self.namespace(model_klass, service)

  raise CacheDir.new("Must set an explicit identifier/name for this cache. Example: 'serviceX-regionY'") unless namespace_prefix

  File.join(SANDBOX, namespace_prefix, safe_class_path(service.class), safe_class_path(model_klass))
end

.namespace_prefix ⇒ Object 



210
211
212
 
# File 'lib/fog/core/cache.rb', line 210

def self.namespace_prefix
  @namespace_prefix
end

.namespace_prefix=(name) ⇒ Object 



206
207
208
 
# File 'lib/fog/core/cache.rb', line 206

def self.namespace_prefix=(name)
  @namespace_prefix = name
end

.safe_class_path(klass) ⇒ Object 



256
257
258
 
# File 'lib/fog/core/cache.rb', line 256

def self.safe_class_path(klass)
  klass.to_s.gsub("::", "_").downcase
end

.valid_for_load?(path) ⇒ Boolean

method to determine if a path can be loaded and is valid fog cache format.

Returns:



157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/fog/core/cache.rb', line 157

def self.valid_for_load?(path)
  data = load_cache(path)
  if data && data.is_a?(Hash)
    missing_attrs = REQUIRED_ATTRIBUTES.reject { |k| data.keys.include?(k) }
    return true if missing_attrs.empty?

    Fog::Logger.warning("Found corrupt items in the cache: #{path}. Expire all & refresh cache soon.\n\nMissing: #{missing_attrs}.\nData:\n#{File.read(path)}")
    return false
  end

  false
end

.write_metadata(h) ⇒ Object

write any metadata - hash information - specific to the namespaced cache in the session.

you can retrieve this in other sessions, as long as namespace_prefix is set you can overwrite metadata over time. see test cases as examples.



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/fog/core/cache.rb', line 218

def self.write_metadata(h)
  if namespace_prefix.nil?
    raise CacheDir.new("Must set an explicit identifier/name for this cache. Example: 'serviceX-regionY'") unless namespace_prefix
  elsif !h.is_a?(Hash)
    raise CacheDir.new("metadta must be a hash of information like {:foo => 'bar'}")
  end

  mpath = File.join(SANDBOX, namespace_prefix, "metadata.yml")
  to_write = if File.exist?(mpath)
               YAML.dump(yaml_load(File.read(mpath)).merge!(h))
             else
               YAML.dump(h)
             end

  mdir = File.join(SANDBOX, namespace_prefix)
  FileUtils.mkdir_p(mdir)

  File.open(mpath, "w") { |f| f.write(to_write) }
end

.yaml_load(path) ⇒ Object

Note:

Starting from Ruby 3.1 we must explicitly tell Psych to allow aliases

Load YAML file with aliases



189
190
191
192
193
194
195
 
# File 'lib/fog/core/cache.rb', line 189

def self.yaml_load(path)
  if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("3.1.0")
    YAML.load(path, aliases: true)
  else
    YAML.load(path)
  end
end

Instance Method Details

#dump ⇒ Object

Dump a Fog::Model resource. Every fog model/instance now has a cache method/object injected in. as such you can use the #dump method to save the attributes and metadata of that instance as cache which can be re-used in some other session.



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/fog/core/cache.rb', line 267

def dump
  if !File.exist?(self.class.namespace(model.class, model.service))
    self.class.create_namespace(model.class, model.service)
  end

  data = {
    identity: model.identity,
    model_klass: model.class.to_s,
    collection_klass: model.collection && model.collection.class.to_s,
    collection_attrs: model.collection && model.collection.attributes,
    model_attrs: model.attributes
  }

  File.open(dump_to, "w") { |f| f.write(YAML.dump(data)) }
end

#dump_to ⇒ Object

the location of where to save this fog model/instance to.



284
285
286
287
288
289
290
291
 
# File 'lib/fog/core/cache.rb', line 284

def dump_to
  # some fog models have an identity field that is duplicate.
  # duplicate identities can mean the cache for that already exists.
  # this means cache duplication is possible.
  #
  # see "dumping two models that have duplicate identity" test case.
  "#{self.class.namespace(model.class, model.service)}/#{model.identity}-#{SecureRandom.hex}.yml"
end