BA
Better Auth•2mo ago
Winston

API Key Metadata is null?

For this configuration with v1.2.3: 
export const auth = betterAuth({
  database: drizzleAdapter(db, {
    provider: "pg",
    usePlural: true,
  }),
  emailAndPassword: {
    enabled: true,
  },
  plugins: [
    apiKey({
      enableMetadata: true,
    }),
    organization(),
  ],
});
export const auth = betterAuth({
  database: drizzleAdapter(db, {
    provider: "pg",
    usePlural: true,
  }),
  emailAndPassword: {
    enabled: true,
  },
  plugins: [
    apiKey({
      enableMetadata: true,
    }),
    organization(),
  ],
});
I am trying a simple create: 
const key = await auth.api.createApiKey({
  body: {
    name: body.name,
    metadata: {
      org: "org",
    },
  },
  fetchOptions: {
    headers: {
      "Content-Type": "application/json",
    },
  },
  headers: c.req.raw.headers,
});
const key = await auth.api.createApiKey({
  body: {
    name: body.name,
    metadata: {
      org: "org",
    },
  },
  fetchOptions: {
    headers: {
      "Content-Type": "application/json",
    },
  },
  headers: c.req.raw.headers,
});
But when I use the key, it's registered as valid, but with metadata set to the string 'null': (Verified this is the case on the DB side as well). 
  const apiKey = c.req.header("x-api-key");
  logger.error(`Received API key: ${apiKey}`);
  if (!apiKey) {
    return c.json(
      { error: "Unauthorized", details: "No API key provided" },
      401,
    );
  }

  const keyValid = await auth.api.verifyApiKey({
    body: {
      key: apiKey,
    },
  });
  if (keyValid.error) {
    return c.json({ error: "Unauthorized", details: "Invalid API key" }, 401);
  }

  const key = await auth.api.getApiKey({
    headers: c.req.raw.headers,
    query: {
      id: keyValid.key?.id ?? "",
    },
  });
  const apiKey = c.req.header("x-api-key");
  logger.error(`Received API key: ${apiKey}`);
  if (!apiKey) {
    return c.json(
      { error: "Unauthorized", details: "No API key provided" },
      401,
    );
  }

  const keyValid = await auth.api.verifyApiKey({
    body: {
      key: apiKey,
    },
  });
  if (keyValid.error) {
    return c.json({ error: "Unauthorized", details: "Invalid API key" }, 401);
  }

  const key = await auth.api.getApiKey({
    headers: c.req.raw.headers,
    query: {
      id: keyValid.key?.id ?? "",
    },
  });
8 Replies
Ping
Ping•2mo ago
Thanks for the report, I'll check it out. @Winston Yeah no clue how we messed up our unit tests but this is definitely a bug. I'll solve it and open a PR and send it here for you to track.
Ping
Ping•2mo ago
Winston
WinstonOP•5w ago
Hi @Ping , what’s the typical timeline for a merged PR to make it to beta, and to be released?
Ping
Ping•5w ago
Usually it's pretty fast. Bekacru says probably today it will be full released
Winston
WinstonOP•5w ago
Awesome I want to ask though @Ping , 
  const keyValid = await auth.api.verifyApiKey({
    body: {
      key: apiKey,
    },
  });

  const key = await auth.api.getApiKey({
    headers: c.req.raw.headers,
    query: {
      id: keyValid.key?.id ?? "",
    },
  });
  const keyValid = await auth.api.verifyApiKey({
    body: {
      key: apiKey,
    },
  });

  const key = await auth.api.getApiKey({
    headers: c.req.raw.headers,
    query: {
      id: keyValid.key?.id ?? "",
    },
  });
in the above code, the return type of keyValid.metadata is the string in the DB without being processed, e.g. "{\"org\":\"gh89j1rtNQDci5tq7eK0cQ9nx7BZodBJ\"}" while in the case of key.metadata, it is an object/record, which I can call key.metadata.org in the above example. Is this intended behavior?
Ping
Ping•5w ago
Nope 😅 I'll fix it. Hey sorry I took a while, I was at work.
Ping
Ping•5w ago
Anyway, the PR is up now. https://github.com/better-auth/better-auth/pull/1719
GitHub
fix(api-key): Results of verify endpoint's metadata isn't parsed ...
Calling verify endpoint returns the stringified version of the metadata. This is fixed now.
Winston
WinstonOP•5w ago
Appreciate it!

Did you find this page helpful?