Introduction to the Image Manager

Welcome to the second lesson of our course on building an image generation service with Go. In our previous lesson, we created the PromptManager struct to handle the formatting of prompts for our image generation process. Now, we'll build upon that foundation by creating the ImageManager struct, which will be responsible for handling the images once they're generated.

The ImageManager serves as a crucial component in our application architecture. While the PromptManager prepares the instructions for image generation, the ImageManager takes care of what happens after an image is created. Its primary responsibilities include:

  1. Storing generated images along with their associated prompts
  2. Converting images to a web-friendly format (base64)
  3. Providing access to the collection of stored images

This component is essential because web applications can't directly work with raw image data. By converting images to base64 strings, we can easily embed them in HTML or send them as JSON responses in our API. Additionally, keeping track of which prompt generated which image allows us to maintain a history of generations and potentially reuse successful prompts.

Let's dive into building this important piece of our image generation service.

Setting Up the Image Manager Struct

To begin, we'll create a new file called image_manager.go in our models directory. This file will contain our ImageManager struct. First, let's set up the basic structure and understand the imports we'll need:

Let's break down these imports:

  • bytes: This package provides functions for the manipulation of byte slices, which we'll use to handle image data in memory.
  • encoding/base64: This package provides functions for encoding binary data to ASCII characters and decoding such encodings back to binary data. We'll use it to convert our images to a string format that can be easily transmitted over HTTP.
  • image and image/jpeg: These packages allow us to decode and encode JPEG images, which we'll use to process the image data.
  • fmt: This package provides formatted errors, which we'll use to wrap image decoding and encoding failures.

Our ImageManager struct starts with a simple field called images, which is a slice of ImageDetails. Each ImageDetails contains:

Converting Images to Base64 Format

One of the key functions of our ImageManager struct is to convert image data into a format that can be easily used in web applications. This conversion happens in two important steps: first, we decode incoming image data from a supported registered format and re-encode it as JPEG for consistent compression and universal browser support. In the code below, JPEG decoding is available because image/jpeg is imported; supporting PNG would require registering PNG decoding with _ "image/png", and TIFF is not supported by this snippet without an additional decoder package. Then, we convert the JPEG binary data to Base64 encoding so it can be safely transmitted in JSON responses or embedded directly in HTML without requiring file system storage.

Let's implement the ImageToBase64 method:

This method takes imageData as input, which will be the response from our image generation API. Let's walk through what's happening:

  1. We decode the raw image data using image.Decode, which reads from a io.Reader.
  2. We create a new bytes.Buffer to hold the processed image.
  3. We encode the image to this buffer in format using .
Building Image Collection Methods

Now that we can convert images to base64, let's implement the methods for adding images to our collection and retrieving the stored images.

This method performs several important tasks:

  1. It calls our ImageToBase64 method to convert the image data to a base64 string.
  2. It creates an ImageDetails entry containing:
    • An ID based on the current length of the images slice (ensuring each image gets a unique identifier)
    • The prompt that was used to generate the image
    • The base64-encoded image data
  3. It appends this entry to our images slice.
  4. It returns the base64 string, which can be immediately used by the caller if needed.
The GetImages Method

This method simply returns the entire slice of image entries, allowing other parts of our application to access all stored images and their associated metadata.

Testing the Image Manager

Now that we've implemented our ImageManager struct, let's create a simple test script to verify that it works correctly. We'll create this in our main.go file:

In this test script, we:

  1. Create an instance of the ImageManager.
  2. Define some fake image data and a test prompt. Note that this fake data won't actually work with our ImageToBase64 method as implemented, but it serves as a placeholder for our test.
  3. Call the AddImage method with our test data.
  4. Print the result and then retrieve and print all stored images.

When running this script with real image data, you would see output similar to:

The base64 string would be much longer in a real application, but I've truncated it here for readability.

Summary and Practice Preview

In this lesson, we've built the ImageManager struct, a crucial component of our image generation service. This struct handles the storage and processing of generated images, converting them to a web-friendly format and maintaining a collection of all images along with their associated prompts.

Let's review what we've learned:

  1. We created a struct with a simple in-memory storage mechanism.
  2. We implemented a method to convert image data to base64 format, making it suitable for web applications.
  3. We built methods to add images to our collection and retrieve all stored images.
  4. We created a simple test script to verify the functionality of our ImageManager.

The ImageManager complements the PromptManager we built in the previous lesson. While the PromptManager prepares the instructions for image generation, the ImageManager handles the results of that generation process. Together, these components form the foundation of our image generation service.

In the upcoming practice exercises, you'll have the opportunity to work with the ImageManager struct, testing its functionality with different types of image data and exploring how it integrates with the rest of our application. You'll also get to experiment with error handling and see how the struct behaves in various scenarios.

In our next lesson, we'll build upon this foundation by implementing the ImageGeneratorService, which will connect to Google's Gemini API to actually generate images based on our prompts. This service will use both the PromptManager and structs we've created so far.

Sign up
Join the 1M+ learners on CodeSignal
Be a part of our community of 1M+ users who develop and demonstrate their skills on CodeSignal